e2e: add logfile for e2e tests #1775
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Good to link the issue, but we should start a PR with a commit message describing the change. We can describe what was done and what will be done later. This helps people to review the change. |
nirs
reviewed
Jan 28, 2025
nirs
reviewed
Jan 28, 2025
nirs
reviewed
Jan 28, 2025
parikshithb
force-pushed
the
e2e_logger
branch
2 times, most recently
from
13a1f0c to
f242964
Compare
nirs
reviewed
Jan 30, 2025
nirs
reviewed
Jan 30, 2025
parikshithb
force-pushed
the
e2e_logger
branch
3 times, most recently
from
5fea441 to
895283d
Compare
nirs
reviewed
Jan 30, 2025
This is clear when you look at the commits, it will help to explain int the commit/pr message why we revert the previous logging hack. |
parikshithb
force-pushed
the
e2e_logger
branch
from
895283d to
c3e3faf
Compare
parikshithb
force-pushed
the
e2e_logger
branch
from
c3e3faf to
fdd8d4c
Compare
This commit introduces a dedicated log file for e2e tests: * Creates a log file (ramen-e2e.log) in the current directory by default. * Log DEBUG level messages to the file and INFO level messages to the console. * Remove caller (file:lineno) from console logs for cleaner output. * Added /e2e/ramen-e2e and /e2e/ramen-e2e.log to gitignore. Signed-off-by: Parikshith <[email protected]>
This reverts commit 2cd063a. which previously redirected e2e test logs to ramen-e2e.log using tee. This change is no longer needed because the new logger implementation now writes to ramen-e2e.log by default. Signed-off-by: Parikshith <[email protected]>
parikshithb
force-pushed
the
e2e_logger
branch
from
fdd8d4c to
9990c5f
Compare
nirs
approved these changes
Feb 2, 2025
| if err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| log := logger.Sugar() | ||
| // TODO: Sync the log on exit |
There was a problem hiding this comment.
It seems that the best way to handle the conflict between os.Exit() and defer is to call it only once in main() or in the case of tests, in TestMain(). This also means we cannot call any function that calls os.Exit() like log.Fatal().
We can do this like this:
func TestMain(m *testing.M) {
os.Exit(run(m))
}
func run(m *testing.M) int {
log := ...
defer func() {
_ = log.Sync()
}()
...
if err != nil {
log.Errorf("error message... : %s", err)
return 1
}
return m.Run()
}
With this we ensure that test failure or setup failure will return non-zero exit code, and defer function will run, and the code is very simple.
But lets no dalay this good change, we can improve this later.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes: #1722